/*
 *  SPAGL Copyright (C) 2008 Sam Pottinger
 *  This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser 
 *  General Public License as published by the Free Software Foundation; either version 2.1 of the License, or 
 *  (at your option) any later version. This library is distributed in the hope that it will be useful, but 
 *  WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
 *  See the GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License along with this library; if not, 
 *  write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 
 */

package spagswing;

import javax.swing.ImageIcon;
import spagcore.SpaglCoreContainer;
import spagcore.SpaglCoreImage;

/**
 * An ImageIcon (javax.swing.ImageIcon) that conforms to the SpaglCoreImage interface
 * @author Sam Pottinger
 */
public class SpaglImage extends ImageIcon implements SpaglCoreImage {
	
	private static final long serialVersionUID = 1L;
	private String imageLocation;
	
	/**
	 * Creates a new image from the specified image location in the system
	 * @param newParent
	 * @param newImageLocation
	 */
	public SpaglImage(SpaglCoreContainer newParent, String newImageLocation)
	{
		super(newImageLocation);
		imageLocation = newImageLocation;
	}

	/**
	 * Gets the height in pixels of this image
	 * 
	 * @return The integer height
	 */
	public int getHeight() {
		return super.getIconHeight();
	}

	/**
	 * Gets the location on the system from where this image came from
	 * @return A string representation of the path of this image
	 */
	public String getLocation() {
		return imageLocation;
	}

	/**
	 * Gets the horizontal size in pixels of this image
	 * 
	 * @return The integer width
	 */
	public int getWidth() {
		return super.getIconWidth();
	}
	
	// Swing does not need manual disposal, so this is here just for cross library purposes
	public void dispose() {}

}
